Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(graphql): Documenting transaction filters and underlying schema #19363

Merged
merged 2 commits into from
Sep 13, 2024

Conversation

amnn
Copy link
Member

@amnn amnn commented Sep 13, 2024

Description

Introducing documentation in a couple of places:

  • Fields in TransactionBlockFilter so that they are documented in the schema
  • Explaining the pattern we use for transaction lookup tables.

Test plan

How did you test the new or updated feature?

Stack


Release notes

Check each box that your changes affect. If none of the boxes relate to your changes, release notes aren't required.

For each box you select, include information after the relevant heading that describes the impact of your changes that a user might notice and any actions they must take to implement updates.

  • Protocol:
  • Nodes (Validators and Full nodes):
  • Indexer:
  • JSON-RPC:
  • GraphQL:
  • CLI:
  • Rust SDK:
  • REST API:

Copy link

vercel bot commented Sep 13, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
sui-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 13, 2024 6:15pm
3 Skipped Deployments
Name Status Preview Comments Updated (UTC)
multisig-toolkit ⬜️ Ignored (Inspect) Visit Preview Sep 13, 2024 6:15pm
sui-kiosk ⬜️ Ignored (Inspect) Visit Preview Sep 13, 2024 6:15pm
sui-typescript-docs ⬜️ Ignored (Inspect) Visit Preview Sep 13, 2024 6:15pm

@amnn amnn mentioned this pull request Sep 13, 2024
8 tasks
Base automatically changed from amnn/tx-affected-idx to main September 13, 2024 18:00
## Description

Document the various filter options for transactions and events (and
tweak the docs for object filters slightly).

## Test plan

:eyes:
@amnn amnn enabled auto-merge (rebase) September 13, 2024 18:15
@amnn amnn merged commit 018cbcb into main Sep 13, 2024
47 of 48 checks passed
@amnn amnn deleted the amnn/gql-docs branch September 13, 2024 18:36
amnn added a commit that referenced this pull request Sep 18, 2024
## Description

Add `TransactionBlockFilter.affectedAddress` as a way to filter
transactions by their relationship to an address without worrying about
what kind of relationship that is.

## Test plan

New E2E 

## Stack

- #19363
- #19371
- #19402 
- #19403

---

## Release notes

Check each box that your changes affect. If none of the boxes relate to
your changes, release notes aren't required.

For each box you select, include information after the relevant heading
that describes the impact of your changes that a user might notice and
any actions they must take to implement updates.

- [ ] Protocol: 
- [ ] Nodes (Validators and Full nodes): 
- [ ] Indexer: 
- [ ] JSON-RPC: 
- [ ] GraphQL: 
- [ ] CLI: 
- [ ] Rust SDK:
- [ ] REST API:
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants